API Documentation
Task.h
1 // Task.h
3 //
5 
6 namespace nkTasks
7 {
13  class DLL_TASKS_EXPORT Task
14  {
15  public :
16 
20  Task () ;
24  virtual ~Task () ;
25 
26  // Getters
30  Thread* getParentThread () const ;
35 
36  // Setters
44  void setParentThread (Thread* thread) ;
52  void setWorkResult (TASK_RESULT result) ;
53 
59  virtual TASK_RESULT onWork () = 0 ;
63  virtual void onWorkDone () = 0 ;
64 
69  virtual void onSuccess () = 0 ;
74  virtual void onFail () = 0 ;
79  virtual void onAbort () = 0 ;
80  } ;
81 }
nkTasks::Thread
Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component.
Definition: Thread.h:12
nkTasks::Task::onWork
virtual TASK_RESULT onWork()=0
nkTasks::Task::getParentThread
Thread * getParentThread() const
nkTasks::Task::getWorkResult
TASK_RESULT getWorkResult() const
nkTasks::Task::onWorkDone
virtual void onWorkDone()=0
nkTasks::Task::onAbort
virtual void onAbort()=0
nkTasks::Task::onFail
virtual void onFail()=0
nkTasks::Task
A task, job that can be submitted to a nkTasks::Thread.
Definition: Task.h:14
nkTasks::TASK_RESULT
TASK_RESULT
Symbolizes a task result code.
Definition: TaskResult.h:12
nkTasks::Task::~Task
virtual ~Task()
nkTasks
Encompasses all API of component NilkinsTasks.
Definition: LogManager.h:7
nkTasks::Task::setWorkResult
void setWorkResult(TASK_RESULT result)
nkTasks::Task::onSuccess
virtual void onSuccess()=0
nkTasks::Task::setParentThread
void setParentThread(Thread *thread)
nkTasks::Task::Task
Task()